Reviewer's Guide

Moves a pytest hook that manipulates the vault/Foreman version source from the global conftest to the Foreman-specific test conftest, so that automatic vault login/version handling only applies to relevant Foreman tests.

Sequence diagram for pytest runtest protocol with Foreman foremanctl marker

sequenceDiagram
    participant Pytest as PytestRunner
    participant ForemanConftest as tests_foreman_conftest
    participant AutoVault as pytest_plugins_auto_vault
    participant Settings as settings
    participant Test as ForemanTest

    Pytest->>ForemanConftest: discover pytest_runtest_protocol hook
    Pytest->>AutoVault: initialize auto_vault plugin

    Pytest->>Test: start test execution
    Pytest->>ForemanConftest: pytest_runtest_protocol(item, nextitem)
    alt item has foremanctl marker
        ForemanConftest->>Settings: set(server.version.source, upstream)
        ForemanConftest->>Pytest: yield to next hook
        Pytest->>AutoVault: perform auto vault login using upstream
        AutoVault-->>Pytest: login complete
        Pytest-->>ForemanConftest: resume hook
        ForemanConftest->>Settings: set(server.version.source, internal)
    else item has no foremanctl marker
        ForemanConftest->>Pytest: yield to next hook
        Pytest->>AutoVault: perform normal behavior
        AutoVault-->>Pytest: complete
        Pytest-->>ForemanConftest: resume hook
    end

    Pytest->>Test: run test body
    Test-->>Pytest: result

File-Level Changes

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.